Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New Tor engine Android test #2268

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

New Tor engine Android test #2268

wants to merge 2 commits into from

Conversation

KoalaSat
Copy link

@KoalaSat KoalaSat commented Jun 26, 2024 •
edited
Loading

Description

This is a POC for including a new Tor engine that is being used by Samourai's Sentinel and Robosats' app.

I implemented a simple POC only for Android, to be able to show how the code looks like. The library is https://github.com/05nelsonm/kmp-tor/tree/master, the iOS compatibility is about to be released in v2.

Happy to answer questions and discuss potential issues or improvements :)

This pull request is categorized as a:

  • New feature
  • Bug fix
  • Code refactor
  • Configuration change
  • Locales update
  • Quality assurance
  • Other

Checklist

  • I’ve run yarn run tsc and made sure my code compiles correctly
  • I’ve run yarn run lint and made sure my code didn’t contain any problematic patterns
  • I’ve run yarn run prettier and made sure my code is formatted correctly
  • I’ve run yarn run test and made sure all of the tests pass

Testing

If you modified or added a utility file, did you add new unit tests?

  • No, I’m a fool
  • Yes
  • N/A

I have tested this PR on the following platforms (please specify OS version and phone model/VM):

  • Android
  • iOS

I have tested this PR with the following types of nodes (please specify node version and API version where appropriate):

  • Embedded LND
  • LND (REST)
  • LND (Lightning Node Connect)
  • Core Lightning (c-lightning-REST)
  • LndHub
  • [DEPRECATED] Core Lightning (Spark)
  • [DEPRECATED] Eclair

Locales

  • I’ve added new locale text that requires translations
  • I’m aware that new translations should be made on the ZEUS Transfix page and not directly to this repo

Third Party Dependencies and Packages

  • Contributors will need to run yarn after this PR is merged in
  • 3rd party dependencies have been modified:
    • verify that package.json and yarn.lock have been properly updated
    • verify that dependencies are installed for both iOS and Android platforms

Other:

  • Changes were made that require an update to the README
  • Changes were made that require an update to onboarding

KoalaSat
KoalaSat commented Jun 26, 2024
View reviewed changes
android/app/src/main/java/com/zeus/tor/TorKmpManager.kt
@@ -0,0 +1,389 @@
package io.bluewallet.bluewallet.tor
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file has been extracted from Library's Sample file https://github.com/05nelsonm/kmp-tor/blob/1.x.x/samples/kotlin/android/src/main/java/io/matthewnelson/kmp/tor/sample/kotlin/android/SampleApp.kt

KoalaSat
KoalaSat commented Jun 26, 2024
View reviewed changes
android/app/src/main/java/com/zeus/TorMobile.java
@@ -0,0 +1,138 @@
package app.zeusln.zeus;
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file has been extracted from Robosats' app https://github.com/RoboSats/robosats/blob/main/mobile/android/app/src/main/java/com/robosats/modules/TorModule.java

KoalaSat
KoalaSat commented Jun 26, 2024
View reviewed changes
utils/TorUtils.ts
break;
}
};
await TorMobile.start();
Copy link
Author

@KoalaSat KoalaSat Jun 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept it because of the previous implementation, but this is not required to be here, it can be called just if the boolean enableTor configuration changes.

With this new engine, if a request is sent while starting, it'll be enqueued and if the app goes to background it won't be necessary to start it again.

@kaloudis kaloudis force-pushed the master branch 6 times, most recently from 1c682d4 to 2068ca3 Compare November 2, 2024 04:39
@kaloudis kaloudis added Accessibility Issues relating to accessibility Tor and removed Accessibility Issues relating to accessibility labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Tor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KoalaSat @kaloudis